Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.ProgressMonitorInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream
              |
              +--com.sun.java.swing.ProgressMonitorInputStream

public class ProgressMonitorInputStream

extends java.io.FilterInputStream

Monitors the progress of reading from some InputStream. Normally invoked in roughly this form:

 InputStream in = new BufferedInputStream(
            new ProgressMonitorInputStream(
                     parentComponent,
                    "Reading "+fileName,
                     new FileInputStream(fileName)));
 

This creates a progress monitor to monitor the progress of reading the input stream. If it's taking a while, a ProgressDialog will be popped up to inform the user. If the user hits the Cancel button an InterruptedIOException will be thrown on the next read. All the right cleanup is done when the stream is closed.

See Also:

ProgressMonitor, JOptionPane

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

ProgressMonitorInputStream(java.awt.Component parentComponent, java.lang.Object message, java.io.InputStream in)

Method Summary

void	close()
ProgressMonitor	getProgressMonitor()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

ProgressMonitorInputStream

public ProgressMonitorInputStream(java.awt.Component parentComponent,
                                  java.lang.Object message,
                                  java.io.InputStream in)

Parameters:

message - Descriptive text to be placed in the dialog box if one is popped up.

parentComponent - The component triggering the operation being monitored.

in - The input stream to be monitored.

Method Detail

getProgressMonitor

public ProgressMonitor getProgressMonitor()

read

public int read()
        throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

read

public int read(byte[] b)
        throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

read

public int read(byte[] b,
                int off,
                int len)
        throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

skip

public long skip(long n)
         throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

close

public void close()
          throws java.io.IOException

Overrides:

close in class java.io.FilterInputStream

reset

public void reset()
          throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream